home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2004 #9 / Amiga Plus CD - 2004 - No. 09.iso / amigaplus / tools / amigaos4_only / spaceagent50_4 / documentation / commodities / spaceagent.readme next >
Text File  |  2004-08-03  |  7KB  |  123 lines
  1. SpaceAgent 50.4
  2.  
  3. SpaceAgent is a full commodity that will monitor any valid system volumes for disk space
  4. which is below a predefined threshold setup by the user.
  5.  
  6. Running SpaceAgent is easy, double click the icon, or type SpaceAgent into a shell (you
  7. will need to specify some parameters - more below).
  8.  
  9.  
  10. ToolTypes
  11.  
  12. The tooltypes listed below can also be used as CLI arguments, and as such require no
  13. further description.
  14.  
  15.     VOLUMES         These are the AmigaDOS volumes to watch, they must 
  16.          obviously be valid disks or errors will occur.  The default is set to 
  17.          'SYS:' as that disk should always exist. Multiple disks can be defined 
  18.          if more than one is required. This is achieved by using the | symbol 
  19.          to separate the volumes - eg: VOLUMES=SYS:|Work:|Play:
  20.  
  21.     INFO            This is the threshold level that is set to notify you that
  22.                     the disks are approaching low space. You can set this to whatever
  23.                     you want, but the default is 20. This value is in MB and is
  24.                     rounded down to the next whole value. This is a global value and
  25.                     will apply to all disks specified.
  26.  
  27.     WARN            Here is where the critical threshold is set, and the default is
  28.                     1MB, but again you can set it to whatever you feel fits your
  29.                     needs better. This, like INFO, is also a global value.
  30.  
  31.     SECS            This has been included for convenience really, and this value
  32.                     represents the number of seconds to wait between disk scans. A
  33.                     reasonable default is 30, but you may want to set this to 60. There
  34.                     is very little happening during a disk scan, so do not be too
  35.                     worried about it stealing valuable CPU cycles if set too often.
  36.                     The more often the disk is scanned the quicker you will know about
  37.                     the low space situation.
  38.  
  39.     CX_PRIORITY     This is the definable priority that the commodity will run at. The
  40.                     higher the value, the closer to the top of the commodity chain this
  41.                     program will run. An ideal value (and default) is 0 (zero), but must
  42.                     be within the range of -127 to 127.
  43.  
  44.     INFOSCRIPT      This tooltype allows you to specify an AmigaDOS script that can 
  45.                     be executed in the event of the INFO threshold being reached. The
  46.                     script is run via the system Execute() routine just prior to the requester
  47.                     appearing. You should supply the full path to the script.
  48.                     An important note here is that any scripts you choose must have the
  49.                     'S' bit set otherwise an error will occur.
  50.  
  51.     WARNSCRIPT      This is as above except the script is run just prior to the WARNING
  52.                     requester appearing. These are global scripts and will be run no
  53.                     matter which disk triggered the event. Please note this script needs
  54.                     the 'S' bit set as above.
  55.  
  56.     DEBUG           This tooltype should not normally be used, but is included in these
  57.                     early releases to enable some fault finding.
  58.  
  59. A typical command line would look like:  'SpaceAgent VOLUMES=OS4:|Work: INFO=20 WARN=5 SECS=60'
  60.  
  61.  
  62.  
  63.  
  64.  
  65. A Brief Overview
  66.  
  67. The operation of the program is simple. After it has started it will sit quietly in the
  68. background watching the disks you specified in the parameters. Once the free space on any
  69. of the disks gets lower than the INFO level, a requester will appear to inform you of this
  70. situation. If allowed to continue the requester will appear once for evey scan, so by
  71. default that will be once every 30 seconds. Pressing 'CANCEL' will not cancel the operation
  72. of the program, but it will supress the requester for the disk in question. SpaceAgent will
  73. continue to monitor the disks looking for the warning situation, and will again show a
  74. requester once this threshold is reached. Pressing 'CONTINUE' will allow the requesters to
  75. keep appearing, and 'CANCEL' will supress the warnings too.
  76.  
  77. You can free up space on the volume in question, which will stop the requesters providing
  78. you have freed sufficient space. By pressing 'CANCEL' to supress the requester for one
  79. volume will NOT supress the requesters for further volumes, and the low space checks are
  80. treated on a 'per disk' basis.
  81.  
  82. If you require the facility to execute an external script, you can specify the path to it
  83. using the script tooltypes described above. Each script will run just before the requester
  84. appears, so you may want to have it launch a program, or simply use the script to start
  85. deleting files to free up space. The choice is yours. You must set the SCRIPT bit in the
  86. script files properties otherwise an error will occur. This is simply 'Protect <file> +s'
  87. on the script file in question. This script should be written in such a way as to make it
  88. applicable to all disks that you are checking, as the script is considered global ie: it
  89. will be launched by any disk not meeting the free space checks.
  90.  
  91. If you do not require the INFO level and just want the critical requesters to appear, set the
  92. inform level to any value less than WARN, but remember it must be a whole value.
  93.  
  94. You can, if you really must, exit the program by issuing a break (CTRL-C) or by selecting
  95. 'REMOVE' from the commodities Exchange program. Space Agent will also quit the current 
  96. instance by running it again.
  97.  
  98. You can also enable and disable the checking of disks from Exchange by using the cycle gadget
  99. intended for the purpose. This will stop the disk checking for all disks, and will put the
  100. program in 'stand-by' mode.
  101.  
  102. This software has been written on an AmigaOne G4XE with AmigaOS4, and as such has been aimed
  103. at this platform. It has not been tested locally on CyberStormPPC or Blizzard PPC hardware.
  104. If you are using this software on that hardware, please let me know if there any problems.
  105.  
  106. The 68K version was compiled using SAS/C 6.58 running under OS4 and has been tested on a
  107. classic Amiga 1200 running OS3.1 or better.
  108.  
  109. You can apply the DEBUG tooltype or CLI parameter which may give more helpful information
  110. in the event that there are problems. (Hopefully, there will not be any)
  111.  
  112. I'd like to thank Brian Sharman for the 68K testing and feature enhancement requests, his help
  113. has made this software what it is today.
  114. I would also like to thank Philippe 'Elwood' Ferrucci for his help in testing this software on the PPC,
  115. and for some of the helpful bug hunts and requests he has contributed.
  116.  
  117. Thanks guys !
  118.  
  119.  
  120. Well that's it, there isn't much more to tell, so enjoy!
  121.  
  122. Simon Archer - bml@blueyonder.co.uk (15-05-2004)
  123.